<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>GstAggregatorPad: GStreamer 1.0 Library Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<link rel="home" href="index.html" title="GStreamer 1.0 Library Reference Manual">
<link rel="up" href="gstreamer-base.html" title="GStreamer Base and Utility Classes">
<link rel="prev" href="GstAggregator.html" title="GstAggregator">
<link rel="next" href="GstBaseParse.html" title="GstBaseParse">
<meta name="generator" content="GTK-Doc V1.28 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description">  <span class="dim">|</span> 
                  <a href="#GstAggregatorPad.description" class="shortcut">Description</a></span><span id="nav_hierarchy">  <span class="dim">|</span> 
                  <a href="#GstAggregatorPad.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_properties">  <span class="dim">|</span> 
                  <a href="#GstAggregatorPad.properties" class="shortcut">Properties</a></span><span id="nav_signals">  <span class="dim">|</span> 
                  <a href="#GstAggregatorPad.signals" class="shortcut">Signals</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="gstreamer-base.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="GstAggregator.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="GstBaseParse.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="GstAggregatorPad"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="GstAggregatorPad.top_of_page"></a>GstAggregatorPad</span></h2>
<p>GstAggregatorPad — <a href="../html/GstPad.html#GstPad-struct"><span class="type">GstPad</span></a> subclass for pads managed by <a class="link" href="GstAggregator.html" title="GstAggregator"><span class="type">GstAggregator</span></a></p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="GstAggregatorPad.functions"></a><h2>Functions</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="functions_return">
<col class="functions_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">
<a href="../html/GstBuffer.html#GstBuffer-struct"><span class="returnvalue">GstBuffer</span></a> *
</td>
<td class="function_name">
<a class="link" href="GstAggregatorPad.html#gst-aggregator-pad-pop-buffer" title="gst_aggregator_pad_pop_buffer ()">gst_aggregator_pad_pop_buffer</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="../html/GstBuffer.html#GstBuffer-struct"><span class="returnvalue">GstBuffer</span></a> *
</td>
<td class="function_name">
<a class="link" href="GstAggregatorPad.html#gst-aggregator-pad-peek-buffer" title="gst_aggregator_pad_peek_buffer ()">gst_aggregator_pad_peek_buffer</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
</td>
<td class="function_name">
<a class="link" href="GstAggregatorPad.html#gst-aggregator-pad-drop-buffer" title="gst_aggregator_pad_drop_buffer ()">gst_aggregator_pad_drop_buffer</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
</td>
<td class="function_name">
<a class="link" href="GstAggregatorPad.html#gst-aggregator-pad-is-eos" title="gst_aggregator_pad_is_eos ()">gst_aggregator_pad_is_eos</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
</td>
<td class="function_name">
<a class="link" href="GstAggregatorPad.html#gst-aggregator-pad-has-buffer" title="gst_aggregator_pad_has_buffer ()">gst_aggregator_pad_has_buffer</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GstAggregatorPad.properties"></a><h2>Properties</h2>
<div class="informaltable"><table class="informaltable" border="0">
<colgroup>
<col width="150px" class="properties_type">
<col width="300px" class="properties_name">
<col width="200px" class="properties_flags">
</colgroup>
<tbody><tr>
<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></td>
<td class="property_name"><a class="link" href="GstAggregatorPad.html#GstAggregatorPad--emit-signals" title="The “emit-signals” property">emit-signals</a></td>
<td class="property_flags">Read / Write</td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GstAggregatorPad.signals"></a><h2>Signals</h2>
<div class="informaltable"><table class="informaltable" border="0">
<colgroup>
<col width="150px" class="signals_return">
<col width="300px" class="signals_name">
<col width="200px" class="signals_flags">
</colgroup>
<tbody><tr>
<td class="signal_type"><span class="returnvalue">void</span></td>
<td class="signal_name"><a class="link" href="GstAggregatorPad.html#GstAggregatorPad-buffer-consumed" title="The “buffer-consumed” signal">buffer-consumed</a></td>
<td class="signal_flags"><a href="/usr/share/gtk-doc/html/gobject/gobject-Signals.html#G-SIGNAL-RUN-FIRST:CAPS">Run First</a></td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GstAggregatorPad.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="name">
<col class="description">
</colgroup>
<tbody>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="GstAggregatorPad.html#GstAggregatorPad-struct" title="struct GstAggregatorPad">GstAggregatorPad</a></td>
</tr>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="GstAggregatorPad.html#GstAggregatorPadClass" title="struct GstAggregatorPadClass">GstAggregatorPadClass</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GstAggregatorPad.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen">    <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject-struct">GObject</a>
    <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GInitiallyUnowned">GInitiallyUnowned</a>
        <span class="lineart">╰──</span> <a href="../html/GstObject.html#GstObject-struct">GstObject</a>
            <span class="lineart">╰──</span> <a href="../html/GstPad.html#GstPad-struct">GstPad</a>
                <span class="lineart">╰──</span> GstAggregatorPad
</pre>
</div>
<div class="refsect1">
<a name="GstAggregatorPad.includes"></a><h2>Includes</h2>
<pre class="synopsis">#include &lt;gst/base/base.h&gt;
</pre>
</div>
<div class="refsect1">
<a name="GstAggregatorPad.description"></a><h2>Description</h2>
<p>Pads managed by a <span class="type">GstAggregor</span> subclass.</p>
<p>This class used to live in gst-plugins-bad and was moved to core.</p>
</div>
<div class="refsect1">
<a name="GstAggregatorPad.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="gst-aggregator-pad-pop-buffer"></a><h3>gst_aggregator_pad_pop_buffer ()</h3>
<pre class="programlisting"><a href="../html/GstBuffer.html#GstBuffer-struct"><span class="returnvalue">GstBuffer</span></a> *
gst_aggregator_pad_pop_buffer (<em class="parameter"><code><a class="link" href="GstAggregatorPad.html" title="GstAggregatorPad"><span class="type">GstAggregatorPad</span></a> *pad</code></em>);</pre>
<p>Steal the ref to the buffer currently queued in <em class="parameter"><code>pad</code></em>
.</p>
<div class="refsect3">
<a name="gst-aggregator-pad-pop-buffer.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>pad</p></td>
<td class="parameter_description"><p>the pad to get buffer from</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gst-aggregator-pad-pop-buffer.returns"></a><h4>Returns</h4>
<p>The buffer in <em class="parameter"><code>pad</code></em>
or NULL if no buffer was
queued. You should unref the buffer after usage. </p>
<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gst-aggregator-pad-peek-buffer"></a><h3>gst_aggregator_pad_peek_buffer ()</h3>
<pre class="programlisting"><a href="../html/GstBuffer.html#GstBuffer-struct"><span class="returnvalue">GstBuffer</span></a> *
gst_aggregator_pad_peek_buffer (<em class="parameter"><code><a class="link" href="GstAggregatorPad.html" title="GstAggregatorPad"><span class="type">GstAggregatorPad</span></a> *pad</code></em>);</pre>
<div class="refsect3">
<a name="gst-aggregator-pad-peek-buffer.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>pad</p></td>
<td class="parameter_description"><p>the pad to get buffer from</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gst-aggregator-pad-peek-buffer.returns"></a><h4>Returns</h4>
<p>A reference to the buffer in <em class="parameter"><code>pad</code></em>
or
NULL if no buffer was queued. You should unref the buffer after
usage. </p>
<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gst-aggregator-pad-drop-buffer"></a><h3>gst_aggregator_pad_drop_buffer ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
gst_aggregator_pad_drop_buffer (<em class="parameter"><code><a class="link" href="GstAggregatorPad.html" title="GstAggregatorPad"><span class="type">GstAggregatorPad</span></a> *pad</code></em>);</pre>
<p>Drop the buffer currently queued in <em class="parameter"><code>pad</code></em>
.</p>
<div class="refsect3">
<a name="gst-aggregator-pad-drop-buffer.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>pad</p></td>
<td class="parameter_description"><p>the pad where to drop any pending buffer</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gst-aggregator-pad-drop-buffer.returns"></a><h4>Returns</h4>
<p> TRUE if there was a buffer queued in <em class="parameter"><code>pad</code></em>
, or FALSE if not.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gst-aggregator-pad-is-eos"></a><h3>gst_aggregator_pad_is_eos ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
gst_aggregator_pad_is_eos (<em class="parameter"><code><a class="link" href="GstAggregatorPad.html" title="GstAggregatorPad"><span class="type">GstAggregatorPad</span></a> *pad</code></em>);</pre>
<div class="refsect3">
<a name="gst-aggregator-pad-is-eos.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>pad</p></td>
<td class="parameter_description"><p>an aggregator pad</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gst-aggregator-pad-is-eos.returns"></a><h4>Returns</h4>
<p> <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the pad is EOS, otherwise <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a>.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gst-aggregator-pad-has-buffer"></a><h3>gst_aggregator_pad_has_buffer ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
gst_aggregator_pad_has_buffer (<em class="parameter"><code><a class="link" href="GstAggregatorPad.html" title="GstAggregatorPad"><span class="type">GstAggregatorPad</span></a> *pad</code></em>);</pre>
<p>This checks if a pad has a buffer available that will be returned by
a call to <a class="link" href="GstAggregatorPad.html#gst-aggregator-pad-peek-buffer" title="gst_aggregator_pad_peek_buffer ()"><code class="function">gst_aggregator_pad_peek_buffer()</code></a> or
<a class="link" href="GstAggregatorPad.html#gst-aggregator-pad-pop-buffer" title="gst_aggregator_pad_pop_buffer ()"><code class="function">gst_aggregator_pad_pop_buffer()</code></a>.</p>
<div class="refsect3">
<a name="gst-aggregator-pad-has-buffer.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>pad</p></td>
<td class="parameter_description"><p>the pad to check the buffer on</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gst-aggregator-pad-has-buffer.returns"></a><h4>Returns</h4>
<p> <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the pad has a buffer available as the next thing.</p>
</div>
<p class="since">Since: 1.14.1</p>
</div>
</div>
<div class="refsect1">
<a name="GstAggregatorPad.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="GstAggregatorPad-struct"></a><h3>struct GstAggregatorPad</h3>
<pre class="programlisting">struct GstAggregatorPad {
  /* Protected by the OBJECT_LOCK */
  GstSegment segment;
};
</pre>
<p>The implementation the GstPad to use with <a class="link" href="GstAggregator.html" title="GstAggregator"><span class="type">GstAggregator</span></a></p>
<div class="refsect3">
<a name="GstAggregatorPad.members"></a><h4>Members</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="300px" class="struct_members_name">
<col class="struct_members_description">
<col width="200px" class="struct_members_annotations">
</colgroup>
<tbody><tr>
<td class="struct_member_name"><p><a href="../html/GstSegment.html#GstSegment-struct"><span class="type">GstSegment</span></a> <em class="structfield"><code><a name="GstAggregatorPad-struct.segment"></a>segment</code></em>;</p></td>
<td class="struct_member_description"><p>last segment received.</p></td>
<td class="struct_member_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="ix03.html#api-index-1.14">1.14</a></p>
</div>
<hr>
<div class="refsect2">
<a name="GstAggregatorPadClass"></a><h3>struct GstAggregatorPadClass</h3>
<pre class="programlisting">struct GstAggregatorPadClass {
  GstPadClass   parent_class;

  GstFlowReturn (*flush)       (GstAggregatorPad * aggpad, GstAggregator * aggregator);
  gboolean      (*skip_buffer) (GstAggregatorPad * aggpad, GstAggregator * aggregator, GstBuffer * buffer);
};
</pre>
<div class="refsect3">
<a name="GstAggregatorPadClass.members"></a><h4>Members</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="300px" class="struct_members_name">
<col class="struct_members_description">
<col width="200px" class="struct_members_annotations">
</colgroup>
<tbody>
<tr>
<td class="struct_member_name"><p><em class="structfield"><code><a name="GstAggregatorPadClass.flush"></a>flush</code></em> ()</p></td>
<td class="struct_member_description"><p>Optional
Called when the pad has received a flush stop, this is the place
to flush any information specific to the pad, it allows for individual
pads to be flushed while others might not be.</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><em class="structfield"><code><a name="GstAggregatorPadClass.skip-buffer"></a>skip_buffer</code></em> ()</p></td>
<td class="struct_member_description"><p>Optional
Called before input buffers are queued in the pad, return <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a>
if the buffer should be skipped.</p></td>
<td class="struct_member_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="ix03.html#api-index-1.14">1.14</a></p>
</div>
</div>
<div class="refsect1">
<a name="GstAggregatorPad.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="GstAggregatorPad--emit-signals"></a><h3>The <code class="literal">“emit-signals”</code> property</h3>
<pre class="programlisting">  “emit-signals”             <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></pre>
<p>Enables the emission of signals such as <a class="link" href="GstAggregatorPad.html#GstAggregatorPad-buffer-consumed" title="The “buffer-consumed” signal"><span class="type">“buffer-consumed”</span></a></p>
<p>Flags: Read / Write</p>
<p>Default value: FALSE</p>
<p class="since">Since: 1.16</p>
</div>
</div>
<div class="refsect1">
<a name="GstAggregatorPad.signal-details"></a><h2>Signal Details</h2>
<div class="refsect2">
<a name="GstAggregatorPad-buffer-consumed"></a><h3>The <code class="literal">“buffer-consumed”</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
user_function (<a class="link" href="GstAggregatorPad.html" title="GstAggregatorPad"><span class="type">GstAggregatorPad</span></a> *gstaggregatorpad,
               <a href="../html/GstBuffer.html#GstBuffer-struct"><span class="type">GstBuffer</span></a>        *arg1,
               <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a>          user_data)</pre>
<p>Flags: <a href="/usr/share/gtk-doc/html/gobject/gobject-Signals.html#G-SIGNAL-RUN-FIRST:CAPS">Run First</a></p>
</div>
</div>
<div class="refsect1">
<a name="GstAggregatorPad.see-also"></a><h2>See Also</h2>
<p>gstcollectpads for historical reasons.</p>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.28</div>
</body>
</html>